/*
 * DBeaver - Universal Database Manager
 * Copyright (C) 2010-2020 DBeaver Corp and others
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jkiss.dbeaver.model.text.parser;


/**
 * Simple rule
 */
public interface TPRule {

	/**
	 * Evaluates the rule by examining the characters available from the provided character scanner.
	 * The token returned by this rule returns <code>true</code> when calling
	 * <code>isUndefined</code>, if the text that the rule investigated does not match the rule's
	 * requirements
	 *
	 * @param scanner the character scanner to be used by this rule
	 * @return the token computed by the rule
	 */
	TPToken evaluate(TPCharacterScanner scanner);
}
